/**
 *    Copyright (C) 2021-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include "mongo/base/error_codes.h"
#include "mongo/base/error_extra_info.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/namespace_string.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/modules.h"

#include <memory>
#include <utility>

namespace mongo {

/**
 * This exception is a workaround for the cases where switch from Shard to Router Role happens
 * without releasing/stashing Shard Role's transaction resources (locks, recovery unit, etc). No new
 * usages (throwers or catchers) should be added without consultation with the Shard Local Catalog
 * Team (CAR).
 *
 * TODO (SPM-3971): Remove this exception once its last user has stopped relying on it.
 */
class MONGO_MOD_NEEDS_REPLACEMENT ShardCannotRefreshDueToLocksHeldInfo final
    : public ErrorExtraInfo {
public:
    static constexpr auto code = ErrorCodes::ShardCannotRefreshDueToLocksHeld;

    ShardCannotRefreshDueToLocksHeldInfo(NamespaceString nss) : _nss(std::move(nss)) {}

    const auto& getNss() const {
        return _nss;
    }

    void serialize(BSONObjBuilder* bob) const override;

    static std::shared_ptr<const ErrorExtraInfo> parse(const BSONObj& obj);

    static ShardCannotRefreshDueToLocksHeldInfo parseFromCommandError(const BSONObj& obj);

private:
    static constexpr auto kNssFieldName = "nss"_sd;

    const NamespaceString _nss;
};

using ShardCannotRefreshDueToLocksHeldException MONGO_MOD_NEEDS_REPLACEMENT =
    ExceptionFor<ErrorCodes::ShardCannotRefreshDueToLocksHeld>;

}  // namespace mongo
